Technical communication is a method of researching and creating information about technical processes or products directed to an audience through media. The information must be relevant to the intended audience. Technical communicators often work collaboratively to create products (deliverables) for various media, including paper, video, and the Internet. Deliverables include online help, user manuals, technical manuals, white papers, specifications, process and procedure manuals, industrial videos, reference cards, data sheets, journal articles, patents, training, business papers, technical reports, and forms and documents.
Technical domains can be of any kind, including the soft and hard sciences, high technology including computers and software, consumer electronics, and business processes and practices.
Technical communication jobs include the following:
Contents |
Technical communication sometimes considered a professional task for which organizations either hire specialized employees, or outsource their needs to communication firms. For example, a professional writer may work with a company to produce a user manual. Other times, technical communication is regarded as a responsibility that technical professionals employ on a daily basis as they work to convey technical information to coworkers and clients. For example, a computer scientist may need to provide software documentation to fellow programmers or clients.
The process of developing information products in technical communication begins by ensuring that the nature of the audience and their need for information is clearly identified. From there the technical communicator researches and structures the content into a framework that can guide the detailed development. As the information product is created, the paramount goal is ensuring that the content can be clearly understood by the intended audience and provides the information that the audience needs in the most appropriate format. This process, known as the 'Writing Process', has been a central focus of writing theory since the 1970s, and some contemporary textbook authors have applied it to technical communication.
Technical communication is important to engineers mainly for the purpose of being professional and accurate. These reports supply specific information in a concise manner and are very clear in their meaning if done correctly.
The technical writing process can be divided into five steps:
All technical communication is done with a particular end in mind. The purpose is usually to facilitate the communication of ideas and concepts to the audience, but may sometimes be used to direct the audience in a particular course of action. The importance of the audience is in the notion that meaning is derived from the audience's interpretation of a piece of work. The purpose may be something as simple as having the audience understand the details of some technological system, or to take a particular action using that system. For example, if the workers in a bank were not properly posting deposits to accounts, someone would write the procedure so these workers might have the correct procedure. Similarly, a sales manager might wonder which of two sites would be a more appropriate choice for a new store, so he would ask someone to study the market and write a report with the recommendations. The sales manager would distribute the report to all parties involved in making that decision. In each of these instances, the person who is writing is transferring knowledge from the person who knows to the person who needs to know. This is the basic definition of technical communication. Dont use this ide for an electronic device typically includes diagrams along with detailed textual explanations. The purpose should serve as a goal that the writer strives toward in writing.
The identification of the audience affects many aspects of communication, from word selection and graphics usage to style and organization. A non-technical audience might not understand, or worse, not even read a document that is heavy with jargon, while a technical audience might crave extra detail because it is critical for their work. Busy audiences do not have time to read an entire document, so content must be organized for ease of searching, for example by the frequent inclusion of headers, white space and other cues that guide attention. Other requirements vary on the needs of the particular audience.
Examples:
In Government:
Technical communication in the government is very particular and detailed. Depending on the particular segment of the government (and not to mention the particular country), the government component must follow distinct specifications. In the case of the US Army, the MIL-spec (Military specification) is used. It is updated continuously and technical communications (in the form of Technical Manuals, Interactive Electronic Technical Manuals, Technical Bulletins, etc.) must be updated as well.
The Department of Defense utilizes Technical Manuals regularly and is a core part of the agency's responsibilities. Although detail oriented in their requirements, the DoD has deficiencies in technical communication. The following paper discusses those deficiencies and identifies the major contributing factors.[1]
The next step is to collect information that is needed for accomplishing the stated purpose. Information may be collected through primary research, where the technical communicator conducts research first-hand, and secondary research, where work published by another person is used as an information source. The technical communicator must acknowledge all sources used to produce his or her work. To ensure that this is done, the technical communicator should distinguish quotations, paraphrases, and summaries when taking notes.
Before writing the initial draft, all the ideas are organized in a way that will make the document flow nicely. A good way of doing this is to write all random thoughts down on a paper, and then circle all main sections, connect the main sections to supporting ideas with lines, and delete all irrelevant material.
Once each idea is organized, the writer can then organize the document as a whole. This can be accomplished in various ways:
Once the whole document is organized, it's a good idea to create a final outline, which will show all the ideas in an easy-to-understand document. Creating an outline makes the entire writing process much easier and will save the author time.
After the outline is completed, the next step is to write the first draft. The goal is to write down ideas from the outline as quickly as possible. Setting aside blocks of one hour or more, in a place free of distractions, will help the writer maintain a flow. Also, the writer should wait until the draft is complete to do any revising; stopping to revise at this stage will break the writer's flow. The writer should start with the section that is easiest for them, and write the summary only after the body is drafted.
The ABC (Abstract, Body, and Conclusion) format can be used when writing a first draft. The Abstract describes the subject to be written about, so that the reader knows what he or she is going to be told in the document. The Body is the majority of the paper, in which the topics are covered in depth. Lastly, the Conclusion section restates the main topics of the paper.
The ABC format can also be applied to individual paragraphs, beginning with a topic sentence that clearly states the paragraph's topic. This is followed by the topic, and finally, the paragraph closes with a concluding sentence.
Once the initial draft is laid out, editing and revising can be done to fine-tune the draft into a final copy. Four tasks transform the early draft into its final form, suggested by Pfeiffer and Boogard:
During this step, the draft is revisited to 1) focus or elaborate on certain topics which deserve more attention, 2) shorten other sections, and 3) shift around certain paragraphs, sentences, or entire topics.
Good style makes the writing more interesting, appealing, or readable. In general the personal writing style of the writer will not be evident in technical writing. Some changes are made by choice, not for correctness, and may include:
Technical writing is a discipline that usually requires a technical writer to make particular use of a style guide. These guides may relate to a specific project, product, company or brand and in general they ensure that technical writing is devoid of a personal style.
At this point, the document can be checked for grammatical errors, such as comma usage and common word confusions (for example, there/their/they're etc.).
Determining the necessary amount of context is important. There needs to be a balance between exuberance, which may lead the audience to take unintended additional meaning from the text, and terseness, which may leave the audience unable to interpret meaning because of missing words.